
/**
 *	\file
 *	Declares the sun_entry_point function.
 *	\author Sean Tromans
 */

#ifndef	SUN_USER_ENTRY_POINT_HPP
#define	SUN_USER_ENTRY_POINT_HPP

#include <vector>
#include <string>

namespace sun
{
	/** Collector of strings containing the command line arguments passed to the application. */
	typedef	std::vector< std::string > command_line_type;
}

/**
 *	Entry point call back for the user to define.
 *	Called once at the begining of the application, returning from this function signals the application to quit.
 *	@param arguments The command line arguments passed to the application.
 *	@return The exit code for the appluacation.
 *	\author Sean Tromans
 */
int	sun_entry_point( sun::command_line_type const & arguments );

#endif	//SUN_USER_ENTRY_POINT_HPP
